home *** CD-ROM | disk | FTP | other *** search
/ Mac Mania 4 / MacMania 4.toast / / Tools&Utilities / MathPad 2.4 / XFuns / XFun kit / Event Handlers next >
Text File  |  1996-03-27  |  3KB  |  60 lines
  1.  
  2. The major new XFun hook in version 2.4 is the ability to access events. This allows XFuns to display windows etc.
  3.  
  4. ------------- Intercepting events
  5. The callback:
  6.  
  7.    void InstallEventHandler(funptr handler)
  8.  
  9. Installs and external event handler of the form:
  10.    short doevent(EventRecord *theEvent)
  11. MathPad calls this handler for every (non-null) event. If the handler returns TRUE, MathPad does no processing on the event. If the handler returns FALSE MathPad will attempt to handle the event. The handler must process ALL events pertaining to its windows and return TRUE. Events that are not handled by the XFun should return FALSE. The XFun must install at least one function before calling InstallEventHandler().
  12.  
  13.    void SetCursorRegion(Cursor *curs,RgnHandle inside)
  14. Allows the XFun to maintain a different cursor in its window. This routine MUST be called in response to a mouse moved event when the XFun window is in front. If the XFun does not need to change the cursor it can pass a NULL region. If the XFun does change the cursor it must also call this routine whenever the region changes.
  15.  
  16.   void DoMenuItem(long selector);
  17. Perform the action for a MathPad menu item. This allows the XFun event handler to call the toolbox MenuSelect(theEvent->where), intercept items it wants and pass back other selections. MathPad assumes that menu selections come from user interaction so XFuns could get into trouble if they arbitrarilly force menu selections. For example if the XFun selected a disabled menu item, disaster is likely.
  18.  
  19.   short GetDocInfo(long *docref,FSSpec *fspec,WindowPtr *plotwindow);
  20. Gets a couple of pieces of info about the document being evaluated. The file spec can be used to save XFun settings in the document's resource fork. The reference number "docref" can be used to check if the current document is the same as the one that last called the XFun. It returns false if there is no open document.
  21.  
  22.  
  23. ------------- Messages from MathPad
  24.  
  25. To enable a little more sophistcated interaction between MathPad and an XFun, MathPad sends a few private messages to XFun event handlers. Messages use the app3Evt type and put a message code in theEvent->message. The document associated with the message can be found by calling GetDocInfo().
  26.  
  27. The following message codes are defined for 2.4.3 in "xfuns.h"
  28.  
  29.  DOCNEW     -- a new document has been created
  30.  DOCOPENED  -- a document has been opened and read in
  31.  DOCCHANGED -- a different document has been selected 
  32.  DOCCLOSE   -- a document is being closed
  33.  DOCSAVED   -- a document has been saved
  34.  PLOTUPDATE -- the plot traces have been re-drawn. The grafport is set.
  35.  APPQUIT    -- MathPad is quitting
  36.  BEGINPARSE -- starting to evaluate
  37.  ENDPARSE   -- finished evaluating
  38.  
  39. The XFun event handler is not required to handle any messages. It should return FALSE for an app3Evt (if it is used or not) so that the message will be passed on to the next XFun.
  40.  
  41.          ---------------------------
  42.  
  43. This folder contains two example CodeWarrior projects using event handlers:
  44.  
  45.    scatter68K.  -- XFun that creates its own window and handles events
  46.      scatter src: scatter.c
  47.      scatter src: doevent.c
  48.      util src:    callbackg.c
  49.      util src:    entry68K.c
  50.                   <MacOS.lib>
  51.  
  52.    sliders68K.  -- XFun that creates slider bar controls
  53.      slider src:  sliders.c
  54.      slider src:  slevent.c
  55.      slider src:  slmain.c
  56.      util src:    callbackg.c
  57.                   <MacOS.lib>
  58.  
  59.  
  60.